Koala Plot Core/io.github.koalaplot.core.line

Package-level declarations

Types

sealed interface AreaBaseline<X, Y>

Specifies baseline coordinates for drawing filled areas on line charts.

fun interface CubicBezierControlPointCalculator

An interface for computing the two control points of a cubic Bézier curve segment. The curve segment connects the current and next data points.

StackArea

sealed class StackArea<X, Y>

A StackArea defines how to draw a line and its subtending area in a StackedAreaPlot.

StackedAreaPlotDataAdapter

class StackedAreaPlotDataAdapter<X>(xData: List<X>, yData: List<List<Float>>) : AbstractList<StackedAreaPlotEntry<X, Float>>

Adapts data for use in a StackedAreaPlot where the input data consists of a List of x-axis coordinates and multiple Lists of Float y-axis coordinates, one per line, where the values are before stacking. This adapter will sum y-axis values to compute each line's height in the StackedAreaPlot. The size of xData and all series in yData must be equal.

StackedAreaPlotEntry

interface StackedAreaPlotEntry<X, Y>

Represents a set of points for a StackedAreaPlot.

StackedAreaStyle

data class StackedAreaStyle(val lineStyle: LineStyle, val areaStyle: AreaStyle)

Provides styling for a single series in a StackedAreaPlot.

Functions

AreaPlot

@Composable

fun <X, Y> XYGraphScope<X, Y>.~~AreaPlot~~(data: List<Point<X, Y>>, areaBaseline: AreaBaseline<X, Y>, areaStyle: AreaStyle, modifier: Modifier = Modifier, lineStyle: LineStyle? = null, symbol: @Composable HoverableElementAreaScope.(Point<X, Y>) -> Unit? = null, animationSpec: AnimationSpec<Float> = KoalaPlotTheme.animationSpec)

An area plot that draws data as points and lines with a filled area to a baseline.

AreaPlot2

@Composable

fun <X, Y> XYGraphScope<X, Y>.AreaPlot2(data: List<Point<X, Y>>, areaBaseline: AreaBaseline<X, Y>, areaStyle: AreaStyle, modifier: Modifier = Modifier.Companion, lineStyle: LineStyle? = null, symbol: @Composable (Point<X, Y>) -> Unit? = null, animationSpec: AnimationSpec<Float> = KoalaPlotTheme.animationSpec)

An area plot that draws data as points and lines with a filled area to a baseline.

catmullRomControlPoints

fun catmullRomControlPoints(tau: Float): CubicBezierControlPointCalculator

Creates a CubicBezierControlPointCalculator that generates control points for a Catmull-Rom spline, resulting in a smooth curve that passes through all data points.

CubicBezierLinePlot

@Composable

fun <X, Y> XYGraphScope<X, Y>.CubicBezierLinePlot(data: List<Point<X, Y>>, modifier: Modifier = Modifier, control: CubicBezierControlPointCalculator = catmullRomControlPoints(DefaultTau), lineStyle: LineStyle? = null, symbol: @Composable (Point<X, Y>) -> Unit? = null, animationSpec: AnimationSpec<Float> = KoalaPlotTheme.animationSpec)

A line plot that draws a smooth, curved line that passes through each data point.

horizontalBezierControlPoints

fun horizontalBezierControlPoints(): CubicBezierControlPointCalculator

Creates a CubicBezierControlPointCalculator that generates control points for a horizontal Bézier curve.

LinePlot

@Composable

fun <X, Y> XYGraphScope<X, Y>.~~LinePlot~~(data: List<Point<X, Y>>, modifier: Modifier = Modifier, lineStyle: LineStyle? = null, symbol: @Composable HoverableElementAreaScope.(Point<X, Y>) -> Unit? = null, animationSpec: AnimationSpec<Float> = KoalaPlotTheme.animationSpec)

A line plot that draws data as points and lines on an XYGraph.

LinePlot2

@Composable

fun <X, Y> XYGraphScope<X, Y>.LinePlot2(data: List<Point<X, Y>>, modifier: Modifier = Modifier, lineStyle: LineStyle? = null, symbol: @Composable (Point<X, Y>) -> Unit? = null, animationSpec: AnimationSpec<Float> = KoalaPlotTheme.animationSpec)

A line plot that draws data as points and lines on an XYGraph.

StackedAreaPlot

@Composable

fun <X, Y> XYGraphScope<X, Y>.StackedAreaPlot(stacks: List<StackArea<X, Y>>, baseline: AreaBaseline<X, Y>, modifier: Modifier = Modifier.Companion, animationSpec: AnimationSpec<Float> = KoalaPlotTheme.animationSpec)

A plot that renders multiple stacked series of data as lines with filled areas between them.

@Composable

fun <X, Y> XYGraphScope<X, Y>.StackedAreaPlot(data: List<StackedAreaPlotEntry<X, Y>>, styles: List<StackedAreaStyle>, firstBaseline: AreaBaseline<X, Y>, modifier: Modifier = Modifier.Companion, animationSpec: AnimationSpec<Float> = KoalaPlotTheme.animationSpec)

A Stacked Area Plot is like a line plot but with filled areas between lines.

stackedAreaPlotEntry

fun <X, Y> stackedAreaPlotEntry(x: X, y: Array<Y>): StackedAreaPlotEntry<X, Y>

Returns an instance of a StackedAreaPlotEntry using the provided data.

StairstepPlot

@Composable

fun <X, Y> XYGraphScope<X, Y>.~~StairstepPlot~~(data: List<Point<X, Y>>, lineStyle: LineStyle, modifier: Modifier = Modifier, symbol: @Composable HoverableElementAreaScope.(Point<X, Y>) -> Unit? = null, areaStyle: AreaStyle? = null, areaBaseline: AreaBaseline<X, Y>? = null, animationSpec: AnimationSpec<Float> = KoalaPlotTheme.animationSpec)

An XY Chart that draws series as points and stairsteps between points.

@Composable

fun <X, Y> XYGraphScope<X, Y>.~~StairstepPlot~~(data: List<Point<X, Y>>, lineStyle: LineStyle, levelLineStyle: (Y) -> LineStyle, cap: StrokeCap = StrokeCap.Square, modifier: Modifier = Modifier, symbol: @Composable HoverableElementAreaScope.(Point<X, Y>) -> Unit? = null, areaStyle: (Y) -> AreaStyle? = null, areaBaseline: AreaBaseline<X, Y>? = null, animationSpec: AnimationSpec<Float> = KoalaPlotTheme.animationSpec)

A StairstepPlot that differentiate lineStyle&areaBaseline at each Y-values based on levelLineStyle.

StairstepPlot2

@Composable

fun <X, Y> XYGraphScope<X, Y>.StairstepPlot2(data: List<Point<X, Y>>, lineStyle: LineStyle, modifier: Modifier = Modifier, symbol: @Composable (Point<X, Y>) -> Unit? = null, areaStyle: AreaStyle? = null, areaBaseline: AreaBaseline<X, Y>? = null, animationSpec: AnimationSpec<Float> = KoalaPlotTheme.animationSpec)

An XY Chart that draws series as points and stairsteps between points.

@Composable

fun <X, Y> XYGraphScope<X, Y>.~~StairstepPlot2~~(data: List<Point<X, Y>>, lineStyle: LineStyle, levelLineStyle: (Y) -> LineStyle, cap: StrokeCap = StrokeCap.Square, modifier: Modifier = Modifier, symbol: @Composable (Point<X, Y>) -> Unit? = null, areaStyle: (Y) -> AreaStyle? = null, areaBaseline: AreaBaseline<X, Y>? = null, animationSpec: AnimationSpec<Float> = KoalaPlotTheme.animationSpec)

A StairstepPlot that differentiate lineStyle&areaBaseline at each Y-values based on levelLineStyle.

StairstepPlot3

@Composable

fun <X, Y> XYGraphScope<X, Y>.StairstepPlot3(data: List<Point<X, Y>>, lineStyle: LineStyle, levelLineStyle: (Y) -> LineStyle, modifier: Modifier = Modifier, cap: StrokeCap = StrokeCap.Square, symbol: @Composable (Point<X, Y>) -> Unit? = null, areaStyle: (Y) -> AreaStyle? = null, areaBaseline: AreaBaseline<X, Y>? = null, animationSpec: AnimationSpec<Float> = KoalaPlotTheme.animationSpec)

A StairstepPlot that differentiate lineStyle&areaBaseline at each Y-values based on levelLineStyle.